home *** CD-ROM | disk | FTP | other *** search
/ Languguage OS 2 / Languguage OS II Version 10-94 (Knowledge Media)(1994).ISO / gnu / para-027.txt < prev    next >
Lisp/Scheme  |  1993-07-18  |  6KB  |  167 lines
  1. How to try Para mode
  2. ====================
  3.  
  4. (A summary of what Para mode does follows the how-to section.)
  5.  
  6.  5 April 1991
  7.  
  8. Robert J. Chassell
  9. bob@ai.mit.edu
  10.  
  11. Para mode is in limited test distribution.  This is a prototype,
  12. experimental system.
  13.  
  14. For information about the Para mode mailing list, please send a
  15. message to `para-request@cs.cmu.edu'.  The members of this mailing
  16. list discusses indexing and retrieval software for unstructured text
  17. as well as Para mode itself and other matters.
  18.  
  19. 1.  The Para mode files are in the `para.tar.Z' distribution file,
  20.     which is located on:
  21.  
  22.         prep.gnu.ai.mit.edu
  23.  
  24.     in the
  25.  
  26.         /pub/gnu
  27.  
  28.     directory, or in a subdirectory of that directory.
  29.  
  30.     (The name of the package includes the version number; it will be
  31.     `para-0.25.tar.Z' or something similar.)
  32.  
  33.     Also, the sources are available on albert.gnu.ai.mit.edu or
  34.     apple-gunkies.gnu.ai.mit.edu or on other machines in that local
  35.     network in the
  36.  
  37.         /gd/gnu/para
  38.  
  39.     directory.
  40.  
  41. 2.  The contents of the `para-0.25.tar.Z' distribution file are:
  42.  
  43.           1928 Apr  4 16:29 Makefile       Make a Para distribution.
  44.           5801 Apr  4 16:30 README         This file.              
  45.         101204 Apr  4 16:20 para.el        The Para mode functions.
  46.          45801 Mar 27 16:13 para.texinfo   How to use Para mode.   
  47.          11670 Feb 14 09:19 what-is.texi   A short discussion.     
  48.  
  49.          21811 Mar 13 23:10 texinfo.el     Necessary Texinfo files.
  50.          65895 Mar 13 22:24 texnfo-upd.el
  51.  
  52.      To uncompress and extract the contents of `para.tar.Z', use the
  53.      following command:
  54.  
  55.         tar xvzf para.tar.Z
  56.  
  57.      The contents of the file expand to about 270 kilobytes in a
  58.      subdirectory of the current directory called `para'.  (Without
  59.      the Texinfo files, the contents expand to about 180 kilobytes.)
  60.  
  61.      If you do not have GNU tar, you may need to unpack in two stages:
  62.  
  63.         uncompress para.tar.Z
  64.         tar xvf para.tar
  65.  
  66. 3.  In addition to `para.el', you need the latest versions of
  67.     `texinfo.el' and `texnfo-upd.el' from the version 2 Texinfo
  68.     distribution in order to run Para mode.  The remaining parts of
  69.     the Texinfo package are not strictly necessary, but all the
  70.     Texinfo commands may be used within Para mode and you may want
  71.     them.
  72.  
  73.     The two minimally necessary Texinfo files are included in the
  74.     Para compressed tar file for your convenience.  But if you have the
  75.     Texinfo 2 package, load that instead and remove the Texinfo files
  76.     that come with the Para mode distribution.
  77.  
  78.     (Possibly earlier versions of `texinfo.el' and `texnfo-upd.el'
  79.     will suffice for experimenting with Para mode.)
  80.  
  81.     To ensure that `para.el',`texinfo.el', and `texnfo-upd.el' are in
  82.     your load-path, you may want to set your load-path as follows: (In
  83.     Emacs, you can evaluate the following expression by positioning
  84.     the cursor after it and typing `C-x C-e'.)
  85.  
  86.         (setq load-path '(nil "/usr/local/emacs/lisp"))
  87.  
  88.     This causes Emacs to look for files in the current directory
  89.     first, then in the `/usr/local/emacs/lisp' directory.
  90.  
  91.     Here is more complex example for setting your load path:
  92.  
  93.         (setq load-path
  94.               (append '("/u/texinfo2" (expand-file-name "~/para"))
  95.                       load-path))
  96.  
  97. 4.  To try out Para mode on its documentation file, type:
  98.  
  99.         M-x load-file para.el
  100.         C-c C-f para.texinfo
  101.  
  102. 5.  If you load version 2 Texinfo files after loading version 1
  103.     Texinfo files, you may want to unset the version 1 Texinfo
  104.     keybindings so the version 2 keybindings take effect.  You could
  105.     place the following commands in you .emacs file, after specifying
  106.     the appropriate load path:
  107.  
  108.     (setq texinfo-mode-map nil)
  109.     (load "texinfo")
  110.  
  111. 6.  You could load Para mode by placing the following in you .emacs file
  112.     after lines (shown just above) for loading version 2 Texinfo
  113.  
  114.     (load "para")
  115.  
  116.     Or you could autoload Para mode with the following commands:
  117.  
  118.     (autoload 'para-mode "para.el" 
  119.       "Para mode is an extension of Texinfo mode. 
  120.     The extension includes some hypertext-like features.  The name
  121.     `Para mode' has been chosen to suggest that it is `beyond' Texinfo
  122.     mode, but not to claim that it is a full-fledged hypertext
  123.     system." t nil)
  124.  
  125.     (autoload 'para-make-file "para.el"
  126.       "Create a Para Mode file and insert its header." t nil)
  127.  
  128.     (autoload 'para-add-node "para.el"
  129.       "Add a node to a Para mode file." t nil)
  130.  
  131.  
  132. What Para mode does:
  133. ====================
  134.  
  135. Para mode includes functions so you can:
  136.  
  137.     * create a formatted, empty Para mode file, (i.e., a Texinfo
  138.       file),
  139.  
  140.     * add a new node, and updating its menu and the node pointers
  141.       (this command does not update a master menu),
  142.  
  143.     * move among nodes with Info like commands,
  144.  
  145.     * automatically update menus and node pointers,
  146.  
  147.     * create a master menu, either with the standard layout or with a
  148.       layout in which the entries are in sequence and indented
  149.       according to hierarchical level,  (Indented menus only work in
  150.       Para mode; they cannot be read in Info.)
  151.  
  152.     * list the master menu in a temporary buffer, as a directory or
  153.       table of contents, with menu commands to goto the nodes and to
  154.       insert cross references in the source, offering defaults and
  155.       completion,
  156.  
  157.     * list recently visited nodes in a temporary buffer, most
  158.       recent first, with menu commands to goto the nodes and to
  159.       insert cross references in the source, offering defaults and
  160.       completion,
  161.  
  162.     * cross reference making with default node names when made from a
  163.       menu list, and default topic descriptions, and completion.
  164.       (Saves typing!)
  165.  
  166. The goal is eventually to merge Para mode with Texinfo mode.
  167.